Kotools Types/kotools.types.number/NonZeroInt/Companion

Companion

object Companion

Contains declarations for holding or building a NonZeroInt.

Properties

Link copied to clipboard
val max: StrictlyPositiveInt

The maximum value a NonZeroInt can have.

Link copied to clipboard
val min: StrictlyNegativeInt

The minimum value a NonZeroInt can have.

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_4_0)
val NonZeroInt.Companion.negativeRange: NotEmptyRange<StrictlyNegativeInt>

The negative range of values a NonZeroInt can have.

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_4_0)
val NonZeroInt.Companion.positiveRange: NotEmptyRange<StrictlyPositiveInt>

The range of positive values a NonZeroInt can have.

Functions

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun create(number: Number): NonZeroInt

Creates a NonZeroInt from the specified number, which may involve rounding or truncation, or throws an IllegalArgumentException if the number equals zero.

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun createOrNull(number: Number): NonZeroInt?

Creates a NonZeroInt from the specified number, which may involve rounding or truncation, or returns null if the number equals zero.

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V3_0_0)
fun random(): NonZeroInt

Returns a random NonZeroInt.